/*
 *  linux/fs/char_dev.c
 *
 *  (C) 1991  Linus Torvalds
 */

#include <errno.h>						// 错误号头文件。包含系统中各种出错号
#include <sys/types.h>					// 类型头文件。定义了基本的系统数据类型

#include <linux/sched.h>				// 调度程序头文件，定义任务结构 task_struct、任务 0 数据等
#include <linux/kernel.h>				// 内核头文件。含有一些内核常用函数的原形定义

#include <asm/segment.h>				// 段操作头文件。定义了有关段寄存器操作的嵌入式汇编函数
#include <asm/io.h>						// io 头文件。定义硬件端口输入/输出宏汇编语句

extern int tty_read(unsigned minor,char * buf,int count);		// 终端读
extern int tty_write(unsigned minor,char * buf,int count);		// 终端写

// 定义字符设备读写函数指针类型
typedef (*crw_ptr)(int rw,unsigned minor,char * buf,int count,off_t * pos);

//// 串口终端读写操作函数。
// 参数：rw - 读写命令；minor - 终端子设备号；buf - 缓冲区；cout - 读写字节数；
// pos - 读写操作当前指针，对于终端操作，该指针无用。
// 返回：实际读写的字节数。若失败则返回出错码。
static int rw_ttyx(int rw,unsigned minor,char * buf,int count,off_t * pos)
{
	return ((rw==READ)?tty_read(minor,buf,count):
		tty_write(minor,buf,count));
}

//// 终端读写操作函数。
// 同上 rw_ttyx()，只是增加了对进程是否有控制终端的检测。
static int rw_tty(int rw,unsigned minor,char * buf,int count, off_t * pos)
{
	// 若进程没有对应的控制终端，则返回出错号。否则调用终端读写函数 rw_ttyx()，并返回
 	// 实际读写字节数。
	if (current->tty<0)
		return -EPERM;
	return rw_ttyx(rw,current->tty,buf,count,pos);
}

//// 内存数据读写。未实现
static int rw_ram(int rw,char * buf, int count, off_t *pos)
{
	return -EIO;
}

//// 物理内存数据读写操作函数。未实现
static int rw_mem(int rw,char * buf, int count, off_t * pos)
{
	return -EIO;
}

//// 内核虚拟内存数据读写函数。未实现
static int rw_kmem(int rw,char * buf, int count, off_t * pos)
{
	return -EIO;
}

// 端口读写操作函数。
// 参数：rw - 读写命令；buf - 缓冲区；cout - 读写字节数；pos - 端口地址。
// 返回：实际读写的字节数。
static int rw_port(int rw,char * buf, int count, off_t * pos)
{
	int i=*pos;
	
	// 对于所要求读写的字节数，并且端口地址小于 64k 时，循环执行单个字节的读写操作。
	// 若是读命令，则从端口 i 中读取一字节内容并放到用户缓冲区中。若是写命令，则从用
	// 户数据缓冲区中取一字节输出到端口 i。
	while (count-->0 && i<65536) {
		if (rw==READ)
			put_fs_byte(inb(i),buf++);
		else
			outb(get_fs_byte(buf++),i);
		i++;
	}

	// 然后计算读/写的字节数，调整相应读写指针，并返回读/写的字节数
	i -= *pos;
	*pos += i;
	return i;
}

//// 内存读写操作函数。内存主设备号是 1。这里仅给出对 0-5 子设备的处理
static int rw_memory(int rw, unsigned minor, char * buf, int count, off_t * pos)
{
	switch(minor) {
		case 0:		// 对应设备文件名是 /dev/ram0 或/dev/ramdisk
			return rw_ram(rw,buf,count,pos);
		case 1:		// /dev/ram1 或/dev/mem 或 ram
			return rw_mem(rw,buf,count,pos);
		case 2:		// /dev/ram2 或/dev/kmem
			return rw_kmem(rw,buf,count,pos);
		case 3:		// /dev/null
			return (rw==READ)?0:count;	/* rw_null */
		case 4:		// /dev/port
			return rw_port(rw,buf,count,pos);
		default:
			return -EIO;
	}
}

// 定义系统中设备种数
#define NRDEVS ((sizeof (crw_table))/(sizeof (crw_ptr)))

// 字符设备读写函数指针表
static crw_ptr crw_table[]={
	NULL,		/* nodev */				/* 无设备(空设备) */
	rw_memory,	/* /dev/mem etc */		/* /dev/mem 等 */
	NULL,		/* /dev/fd */			/* /dev/fd 软驱 */
	NULL,		/* /dev/hd */			/* /dev/hd 硬盘 */
	rw_ttyx,	/* /dev/ttyx */			/* /dev/ttyx 串口终端 */
	rw_tty,		/* /dev/tty */			/* /dev/tty 终端 */
	NULL,		/* /dev/lp */			/* /dev/lp 打印机 */
	NULL};		/* unnamed pipes */		/* 未命名管道 */


//// 字符设备读写操作函数。
// 参数：rw -读写命令；dev -设备号；buf -缓冲区；count -读写字节数；pos -读写指针。
// 返回：实际读/写字节数。
int rw_char(int rw,int dev, char * buf, int count, off_t * pos)
{
	crw_ptr call_addr;

	// 如果设备号超出系统设备数，则返回出错码。如果该设备没有对应的读/写函数，也返回出
 	// 错码。否则调用对应设备的读写操作函数，并返回实际读/写的字节数。
	if (MAJOR(dev)>=NRDEVS)
		return -ENODEV;
	if (!(call_addr=crw_table[MAJOR(dev)]))
		return -ENODEV;
	return call_addr(rw,MINOR(dev),buf,count,pos);
}
